Dartmouth API Developer Portal

Computing-Infrastructure-Components API

Returns information about computing infrastructure components (hosts, services, databases,...). It returns one record for each unique component.

Rating

Attribute Value
Highly Available Yes
Cache Refresh Interval Variable (Certain components are real-time, others could take hours)
Filtering Yes

Required Scopes

Scope Description
urn:dartmouth:computing.infrastructure.components:read This scope is required to read any records. Granting of this scope is approved by Infrastructure Services/Advanced Computing Lab
urn:dartmouth:computing.infrastructure.components:write This scope grants write access to all attribute
urn:dartmouth:computing.infrastructure.components:write_pxe This scope grants write access to the pxe_status attribute

Request

GET /api/computing/infrastructure/components

Required Headers

Authorization: Bearer {jwt}

Parameters

Parameter Name Type Description Valid values Required

(standard filter parameters)

Notes on usage

Components are returned as a collection; may return an empty collection if filter parameters don't match any records.

Returns

Status Code Description
200 Successful request

Sample Request

https://api.dartmouth.edu/api/computing/infrastructure/components?type=database_instance&name=jc*

Sample Return

[
    {
        "cluster": "rcikube2",
        "owner_id": "d20964h",
        "type": "database_instance",
        "created_by": "d20964h",
        "database_type": "mariadb",
        "hostname": "jc-mariadb-a3c3-db.c.dartmouth.edu",
        "environment": "dev",
        "protected": {},
        "name": "jc-mariadb-a3c3-db",
        "database_version": "10.7.1",
        "location": "kubernetes",
        "sourced_from": "dashboard",
        "created_date": "2022-02-01T23:06:45Z",
        "owner_type": "user",
        "status": "READY",
        "id": "61f94369322da10ae7b18e4b"
    },
    {
        "cluster": "rcikube2",
        "owner_id": "d20964h",
        "type": "database_instance",
        "created_by": "d20964h",
        "database_type": "mysql",
        "hostname": "jc-mysql-f2c3-db.c.dartmouth.edu",
        "environment": "dev",
        "protected": {},
        "name": "jc-mysql-f2c3-db",
        "database_version": "8.0.26",
        "location": "kubernetes",
        "sourced_from": "dashboard",
        "created_date": "2022-01-09T23:06:45Z",
        "owner_type": "user",
        "status": "READY",
        "id": "61fa77edc25b140a46deefd3"
    }
]